API Documentation
Function.h
1 // Function.h
3 //
5 
6 namespace nkScripts
7 {
49  class DLL_SCRIPTS_EXPORT Function
50  {
51  public :
52 
53  // Attributes
55 
56  public :
57 
63  Function (const char* name) ;
67  virtual ~Function () ;
68 
69  // Getters
73  const char* getName () const ;
74 
75  // Parameters
94  void addParameter (FUNCTION_PARAMETER_TYPE type, const char* userTypeName = "") ;
95 
96  // Function
102  void setFunction (FunctionCallback function) ;
103 
107  void reset () ;
108  } ;
109 }
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkScripts::Function::getName
const char * getName() const
nkScripts::Function::defaultFunction
OutputValue defaultFunction(const DataStack &stack)
The default place holder function. Set by default.
nkScripts::Function::~Function
virtual ~Function()
nkScripts::Function::setFunction
void setFunction(FunctionCallback function)
nkScripts::DataStack
std::vector< FunctionParameter > DataStack
A data stack, mainly used for parameters.
Definition: FunctionDefines.h:8
nkScripts::FunctionParameter
A function parameter, used within the stack of arguments.
Definition: FunctionParameter.h:25
nkScripts::Function::addParameter
void addParameter(FUNCTION_PARAMETER_TYPE type, const char *userTypeName="")
nkScripts::Function::Function
Function(const char *name)
nkScripts::FunctionCallback
std::function< OutputValue(const DataStack &)> FunctionCallback
A callback in C++, the script environment will call when tied.
Definition: FunctionDefines.h:10
nkScripts::Function::reset
void reset()
nkScripts::FUNCTION_PARAMETER_TYPE
FUNCTION_PARAMETER_TYPE
Describes a variable type.
Definition: FunctionParameterType.h:12
nkScripts::Function
Holds information, and controls, over a function in a scripting environment.
Definition: Function.h:50